/**
 * Copyright © 2008, EMC Corporation.
 * Redistribution and use in source and binary forms, with or without modification, 
 * are permitted provided that the following conditions are met:
 *
 *     + Redistributions of source code must retain the above copyright notice, 
 *       this list of conditions and the following disclaimer.
 *     + Redistributions in binary form must reproduce the above copyright 
 *       notice, this list of conditions and the following disclaimer in the 
 *       documentation and/or other materials provided with the distribution.
 *     + The name of EMC Corporation may not be used to endorse or promote 
 *       products derived from this software without specific prior written 
 *       permission.
 *
 *      THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 *      "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 
 *      TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 *      PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 
 *      BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 *      CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 *      SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 *      INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *      CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 *      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 *      POSSIBILITY OF SUCH DAMAGE.
 */
package com.emc.esu.api {
	/**
	 * Base ESU error class that is thrown from the API methods.  Contains an
	 * error code that can be mapped to the standard ESU error codes.
	 */
	public class EsuError extends Error {
		private var _cause:Error;
		
	    /**
	     * Creates a new ESU error with the given message, code, and cause
	     * @param message the error message
	     * @param cause the error that caused the failure
	     * @param code the error code
	     */
	    public function EsuError( message:String, cause:Error = null, code:int = 0 ) {
	        super( message, code );
	        this._cause = cause;
	    }
	    	
	    /**
	     * Returns the error code associated with the error.  If unknown (the
	     * error did not originate inside the ESU server), the code will be zero.
	     * @return the error code
	     */
	    public function getCode():int {
	        return errorID;
	    } 
	    
	    /**
	     * Gets the error that caused this error.
	     * @return the cause
	     */
	    public function getCause():Error {
	    	return _cause;
	    }
		
		public function get cause():Error {
			return _cause;
		}
	}
}